MouseEvent

A mouse event that provides access to the mouse event data.

This event occurs when a user performs an action with a pointing device (such as a mouse), for example moves the mouse or clicks a mouse button.

Inheritors

Types

Link copied to clipboard
enum Button
A DOM mouse button.

Functions

Link copied to clipboard
abstract fun button(): MouseEvent.Button
Returns a button pressed during events caused by pressing or releasing one or multiple buttons.
Link copied to clipboard
abstract fun clickCount(): Int
Returns the count of consecutive clicks that happened in a short amount of time for mouse events, such as "click", "mouseDown, "mouseUp".
Link copied to clipboard
abstract fun clientLocation(): Point
Returns the location of the mouse cursor in the local (DOM content) coordinate system at the time the event occurred.
Link copied to clipboard
Returns an Optional that contains the event target that represents the element to which the event handler has been attached, otherwise an empty Optional.
Link copied to clipboard
abstract fun isBubbles(): Boolean
Returns true if the event bubbles up through the DOM, otherwise false.
Link copied to clipboard
abstract fun isCancelable(): Boolean
Returns true when the event can be canceled, and therefore prevented as if the event never happened.
Link copied to clipboard
abstract fun isTrusted(): Boolean
Returns true if the event is trusted, and therefore was generated by a user action.
Link copied to clipboard
abstract fun keyModifiers(): KeyModifiers
Returns the key modifiers that are applied to the event.
Link copied to clipboard
abstract fun offsetLocation(): Point
Returns the location of the mouse cursor in the component's coordinate system at the time the event occurred.
Link copied to clipboard
abstract fun pageLocation(): Point
Returns the location of the mouse cursor in the document coordinate system at the time the event occurred.
Link copied to clipboard
abstract fun phase(): EventPhase
Returns the event phase.
Link copied to clipboard
abstract fun preventDefault()
Informs the browser that if the event is not explicitly handled, its default action should not be performed.
Link copied to clipboard
abstract fun screenLocation(): Point
Returns the location of the mouse cursor in the screen's coordinate system at the time the event occurred.
Link copied to clipboard
abstract fun stopPropagation()
Informs the browser that the event should not propagate in the capturing and bubbling phases.
Link copied to clipboard
abstract fun target(): Optional<EventTarget>
Returns an Optional that contains the element on which the event occurred if it exists, otherwise an empty Optional.
Link copied to clipboard
abstract fun type(): EventType
Returns the event type.